Skip to main content

Interface: StreamrClientConfig

Properties​

auth​

• Optional auth: ProviderAuthConfig | PrivateKeyAuthConfig

Authentication: identity used by this StreamrClient instance. Can contain member privateKey or (window.)ethereum

cache​

• Optional cache: Object

Type declaration​

NameType
maxAge?number
maxSize?number

contracts​

• Optional contracts: Object

Type declaration​

NameTypeDescription
ethereumNetworks?Record<string, EthereumNetworkConfig>-
mainChainRPCs?ChainConnectionInfo-
maxConcurrentCalls?number-
storageNodeRegistryChainAddress?string-
streamRegistryChainAddress?string-
streamRegistryChainRPCs?ChainConnectionInfo-
streamStorageRegistryChainAddress?string-
theGraphUrl?stringSome TheGraph instance, that indexes the streamr registries

decryption​

• Optional decryption: Object

Type declaration​

NameType
keyRequestTimeout?number
maxKeyRequestsPerSecond?number

gapFill​

• Optional gapFill: boolean

gapFillTimeout​

• Optional gapFillTimeout: number

id​

• Optional id: string

Custom human-readable debug id for client. Used in logging.

logLevel​

• Optional logLevel: [LogLevel](../API Reference#loglevel)

maxGapRequests​

• Optional maxGapRequests: number

metrics​

• Optional metrics: boolean | { maxPublishDelay?: number ; periods?: { duration: number ; streamId: string }[] }

network​

• Optional network: Object

Type declaration​

NameType
acceptProxyConnections?boolean
disconnectionWaitTime?number
iceServers?readonly IceServer[]
id?string
location?Location
newWebrtcConnectionTimeout?number
peerPingInterval?number
rttUpdateTimeout?number
trackerConnectionMaintenanceInterval?number
trackerPingInterval?number
trackers?TrackerRegistryContract | TrackerRegistryRecord[]
webrtcDatachannelBufferThresholdHigh?number
webrtcDatachannelBufferThresholdLow?number
webrtcDisallowPrivateAddresses?boolean

orderMessages​

• Optional orderMessages: boolean

Attempt to order messages

retryResendAfter​

• Optional retryResendAfter: number